|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.doclinx.ftxml.CatalogManager
The class is the PRIMARY API of the TeraXML full-text search build and management package. A catalog is a collection that comprises a database of documents. The methods of this class allow users to define, build, and update a catalog that can then be searched. While XML is the primary file type, most common text formats are supported. A directory contains all information concerning a catalog. Catalogs usually are built from an existing corpus of documents, with changes and deletions added over time. A "primary" database holds the main set of documents and an update database holds recent changes. These 2 databases can be merged into a single primary database from time-to-time for better performance. A catalog is first created, then files are "added". Adding files does NOT make them searchable. The next step after adding is to perform an update which indexes the new data. Note that any active search handles are locked out for a very brief time when the update is posted and the search class objects are updated. All catalog information should be obtained via the catalog and catalog seach objects and not retained in applications. Once an initial update has been performed, all information is searchable. When an application is finished adding or updating the catalog, the class object is closed. Files can be added dynamically to the catalog at any time. All methods in this class are thread safe.
CatalogSearch
Field Summary | |
static int |
ADD_MODE_AUTODEL
catAddFile mode parameter for controlling adding files to catalog:
If file(s) exist, then delete current entry and then add. |
static int |
ADD_MODE_DIR
catAddFile mode parameter for controlling adding files to catalog:
sSource parameter is a directory path.
|
static int |
ADD_MODE_FILE
catAddFile mode parameter for controlling adding files to catalog:
sSource parameter is a single file path. |
static int |
ADD_MODE_IGNOREDUP
catAddFile mode parameter to skip duplicate file names. |
static int |
ADD_MODE_INPUTCBACK
catAddFile mode parameter for controlling adding files to catalog:
sSource parameter is a file name in the default mode.
|
static int |
ADD_MODE_JDBC
catAddFile mode parameter for extracting data from a db via JDBC |
static int |
ADD_MODE_LOF
catAddFile mode parameter for controlling adding files to catalog:
sSource parameter is a file containing path names,
one path name per line. |
static int |
ADD_MODE_MAPFILE
catAddFile mode parameter for controlling adding files to catalog:
sSource parameter is a map file. |
static int |
ADD_MODE_MODIFIED
catAddFile mode parameter for controlling adding files to catalog:
If file(s) exist in catalog and have been changed, delete entry
and add new version. |
static int |
ADD_MODE_NODUPCHK
catAddFile mode parameter to prevent duplicate file name check. |
static int |
ADD_MODE_PROCESSFILE
catAddFile mode parameter for controlling adding files to catalog:
C++ version ONLY! |
static int |
ADD_MODE_RECOVER
catAddFile mode parameter for controlling adding files to catalog:
C++ version ONLY! |
static int |
ADD_MODE_RESTART
catAddFile mode parameter for controlling adding files to catalog:
C++ version ONLY! |
static java.lang.String |
ARCH_SEP
Separtor characters for appended information with composite and archive files. |
static int |
CAT_ADDERROR
CatalogManager Error Code. |
static int |
CAT_ADDEXECERROR
CatalogManager Error Code. |
static int |
CAT_ATTRS
Catalog record component ID. |
static int |
CAT_AUX_ABSTRACT
|
static int |
CAT_AUX_ADDTEXT
|
static int |
CAT_AUX_ALTTITLE
|
static int |
CAT_AUX_ENCODING
|
static int |
CAT_AUX_PARMS
|
static int |
CAT_AUX_TITLE
Sub-field defintions for CAT_AUXSTR For item CAT_AUXSTR, the string returned contains 6 sub-fields, each separated by '\n'. |
static int |
CAT_AUXINFO
Catalog record component ID. |
static int |
CAT_AUXSTR
Catalog Item String item access code. |
static int |
CAT_BADHANDLE
CatalogManager Error Code. |
static int |
CAT_BUFFERSIZE
CatalogManager Error Code. |
static int |
CAT_CONTEXTFAIL
CatalogManager Error Code. |
static int |
CAT_CONTEXTMERGE
CatalogManager Error Code. |
static int |
CAT_CREATEPARSER
CatalogManager Error Code. |
static int |
CAT_CREATEXML
CatalogManager Error Code. |
static int |
CAT_DATE1
Catalog record component ID. |
static int |
CAT_DATE2
Catalog record component ID. |
static int |
CAT_DATE3
Catalog record component ID. |
static int |
CAT_DEFHASH
Buffering tuning parameters |
com.doclinx.jftr.BLList |
cat_DelList
|
static int |
CAT_DIRERROR
CatalogManager Error Code. |
static int |
CAT_DPERROR
CatalogManager Error Code. |
static int |
CAT_DUPERROR
CatalogManager Error Code. |
static int |
CAT_ERROR
CatalogManager Error Code. |
static int |
CAT_EXISTSERROR
CatalogManager Error Code. |
static java.lang.String |
CAT_EXT
Default catalog specific file name extensions. |
int |
cat_ExtendedError
Extended error code for error types with multiple causes |
static int |
CAT_FILEERROR
CatalogManager Error Code. |
static int |
CAT_FILENAME
Catalog record component IDs. |
static int |
CAT_FILEOFFSET
Catalog record component ID. |
static int |
CAT_FILEOPENERROR
CatalogManager Error Code. |
static int |
CAT_FILESIZE
Catalog record component ID. |
static int |
CAT_FILESTR
These are the 3 base defined strings in a CatalogItem class.
|
static int |
CAT_FILETYPE
Catalog record component ID. |
static int |
CAT_FILTERERROR
CatalogManager Error Code. |
static java.lang.String |
CAT_FIXED
Default catalog object file name. |
static int |
CAT_FIXEDERROR
CatalogManager Error Code. |
byte[] |
cat_Flds
The field types found in a catalog record. |
static int |
CAT_FUZZYERROR
CatalogManager Error Code. |
static int |
CAT_FUZZYMERGE
CatalogManager Error Code. |
static int |
CAT_FUZZYOPEN
CatalogManager Error Code. |
boolean |
cat_FuzzySearchEnable
Indicates that fuzzy seaching is enabled for catalog. |
static java.lang.String |
CAT_HASH
Default catalog object file name. |
static int |
CAT_HASHERROR
CatalogManager Error Code. |
static java.lang.String |
CAT_INF
Default catalog configuration file name. |
static int |
CAT_INFO
Catalog record component ID. |
boolean |
cat_IsObsolete
deprecated |
static int |
CAT_LIBERROR
CatalogManager Error Code. |
static int |
CAT_LICENSEEXPIRED
CatalogManager Error Code. |
static int |
CAT_LICENSEINVALID
CatalogManager Error Code. |
com.doclinx.jftr.Log |
cat_Log
|
static java.lang.String |
CAT_LOG
Default catalog specific file name extensions. |
java.lang.String |
CAT_LOG_FILENAME
Default catalog indexer log file name |
static int |
CAT_LOGICERROR
CatalogManager Error Code. |
static int |
CAT_LSTERROR
CatalogManager Error Code. |
int |
cat_MaxPrimaryItem
The maximum document ID in a primary database. |
static int |
CAT_MERGEERROR
CatalogManager Error Code. |
int |
cat_Mode
Update mode for catalog |
java.lang.String |
cat_Name
Name of this catalog object. |
byte |
cat_nFields
The number of fields in a catalog record. |
static int |
CAT_NOPRIMARY
CatalogManager Error Code. |
static int |
CAT_NOTFOUND
CatalogManager Error Code. |
static int |
CAT_NOTIMPLEMENTED
CatalogManager Error Code. |
static int |
CAT_NOUPDATE
CatalogManager Error Code. |
static int |
CAT_OPENREADONLY
catOpen mode parameter values: Open catalog for search |
static int |
CAT_OPENRESTORE
catOpen mode parameter values: Allow catalog RESTORE |
static int |
CAT_OPENUPDATE
catOpen mode parameter values: Open catalog for update |
static int |
CAT_PARMERROR
CatalogManager Error Code. |
java.lang.String |
cat_Path
Path location of catalog directory. |
static int |
CAT_PROCESSERROR
CatalogManager Error Code. |
static int |
CAT_QUERYERROR
CatalogManager Error Code. |
static int |
CAT_READONLYERROR
CatalogManager Error Code. |
static java.lang.String |
CAT_RESTORE
Default catalog restore file name. |
static int |
CAT_SEARCHERROR
CatalogManager Error Code. |
static int |
CAT_SECURITYERROR
CatalogManager Error Code. |
static int |
CAT_SHAREERROR
CatalogManager Error Code. |
static int |
CAT_SPARMERROR
CatalogManager Error Code. |
com.doclinx.ftxml.SRC2STF_PARMS |
cat_sParms
|
boolean |
cat_StemEnable
Indicates that stemming has been enabled for catalog. |
static int |
CAT_STEMERROR
CatalogManager Error Code. |
static int |
CAT_STEMMERGE
CatalogManager Error Code. |
static int |
CAT_STEMOPEN
CatalogManager Error Code. |
static int |
CAT_STFERROR
CatalogManager Error Code. |
static java.lang.String |
CAT_STRS
Default catalog object file name. |
static int |
CAT_SUCCESS
ERROR RETURNS (CatalogManager API). |
static java.lang.String |
CAT_TMP
Default catalog specific file name extensions. |
static int |
CAT_TO
CatalogManager Error Code. |
static int |
CAT_UNKNOWNERROR
CatalogManager Error Code. |
static int |
CAT_URLSTR
Catalog Item String item access code. |
static int |
CAT_USERABORT
CatalogManager Error Code. |
static int |
CAT_VARERROR
CatalogManager Error Code. |
com.doclinx.ftxml.Map |
cat_XMLSemantics
|
static int |
CLEAR_SEMANTICS
catSetXMLSemantics action parameter values for XPATH semantics.
|
static java.lang.String |
COMP_SEP
Separator for Thesaurus entry. |
static java.lang.String |
CONFIG_FILE
Default configuration file name. |
static java.lang.String |
CONTEXT_IDX
Default catalog specific file name extensions. |
static java.lang.String |
CONTEXT_IDX2
Default catalog specific file name extensions. |
static java.lang.String |
CONTEXT_IDXP
Default catalog specific file name extensions. |
static java.lang.String |
CONTEXT_IDXU
Default catalog specific file name extensions. |
static java.lang.String |
CONTEXT_STR
Default catalog specific file name extensions. |
static java.lang.String |
CONTEXT_STR2
Default catalog specific file name extensions. |
static java.lang.String |
CONTEXT_STRP
Default catalog specific file name extensions. |
static java.lang.String |
CONTEXT_STRU
Default catalog specific file name extensions. |
static java.lang.String |
COPYRIGHT
Default copyright file name. |
static byte |
DEFAULT_CONTEXT_AAIDX
The default FTR aaidx value for context indexes. |
static int |
DETECT_FILTER
filter parameter in catAddFile:
Parser attempts to determine format of file and
then best filter to use. |
static java.lang.String |
EXE_NAME
Default catalog add process executable name. |
static int |
FIND_MODE_ALL
catFindFile mode parameter for controlling which file to locate
in the catalog.
|
static int |
FIND_MODE_DEL
catFindFile mode parameter. |
static int |
FIND_MODE_NOTDEL
catFindFile mode parameter. |
static int |
FIXED_BLKMIN
Start of section for buffering system constants. |
static int |
FIXED_ELTS
Buffering tuning parameters |
static int |
FLD_BITS32
Catalog item field type. |
static int |
FLD_DATE
Catalog item field type. |
static int |
FLD_EOD
Catalog item field End of list marker. |
static int |
FLD_MASK
Catalog item field type mask. |
static int |
FLD_STRING
Catalog item field type. |
static int |
FLD_UINT16
Catalog item field type. |
static int |
FLD_UINT32
Catalog item field type. |
static int |
FLD_UINT64
Catalog item field type. |
static java.lang.String |
FUZZY_PRM
Default catalog specific file name extensions. |
static java.lang.String |
FUZZY_UPD
Default catalog specific file name extensions. |
static java.lang.String |
FUZZY_UPD2
Default catalog specific file name extensions. |
static int |
GENERIC_FILTER
filter parameter in catAddFile:
Use general filter to parse based on file type. |
static int |
HASH_BLKMIN
Buffering tuning parameters |
static int |
HTML_FILTER
filter parameter in catAddFile:
Use HTML filter only (HTML data assumed). |
static int |
LRU_BLKMIN
Buffering tuning parameters |
static int |
LRU_BLKSIZE
Buffering tuning parameters |
static int |
MAX_FLD
Catalog entry fields and types. |
static int |
MODE_COMPRESS_CAT
catUpdate mode parameter (bit field setting) |
static int |
MODE_IMPORT_AUTODEL
catImportCatalog mode parameter (bit field setting) |
static int |
MODE_IMPORT_HASHLOAD
catImportCatalog mode parameter (bit field setting) |
static int |
MODE_IMPORT_NODUPCHK
catImportCatalog mode parameter (bit field setting) |
static int |
MODE_MIN_LOCSIZE
catUpdate mode parameter (bit field setting) |
static int |
MODE_PRIMARY
catUpdate mode parameter for controlling update process.
|
static int |
MODE_REHASH
catUpdate mode parameter (bit field setting) |
static int |
MODE_REMOVE_DELS
catUpdate mode parameter (bit field setting) |
static int |
MODE_UPDATE
catUpdate mode parameter (bit field setting) |
static int |
NO_FILTER
filter parameter in catAddFile:
Indicates STF format for file(s) being added (no filter) |
static char |
PATH_DELIM
Character for separating path expressions. |
static java.lang.String |
PATH_DELIMS
|
static java.lang.String |
PRIMARY_EXT
Default catalog specific file name extensions. |
static java.lang.String |
STEM_PRM
Default catalog specific file name extensions. |
static java.lang.String |
STEM_UPD
Default catalog specific file name extensions. |
static java.lang.String |
STEM_UPD2
Default catalog specific file name extensions. |
static java.lang.String |
STF_EXT
Default catalog specific file name extensions. |
static int |
STRS_BLKMIN
Buffering tuning parameters |
static java.lang.String |
TEMPDB_EXT
Default catalog specific file name extensions. |
static java.lang.String |
TEMPLATE
Default template file name. |
static int |
TEXT_FILTER
filter parameter in catAddFile:
Use text only (no markup) filter. |
static java.lang.String |
THES_EXT
Default catalog specific file name extensions. |
static java.lang.String |
UPDATE_EXT
Default catalog specific file name extensions. |
static java.lang.String |
UPDATE2_EXT
Default catalog specific file name extensions. |
static com.doclinx.ftxml.UpdateLock |
updateLock
|
static int |
XML_ABSTRACT_TAG
catSetXMLSemantics action parameter. |
static int |
XML_ADD2_DRI0_TAG
catSetXMLSemantics action parameter. |
static int |
XML_ATTR_1WRD_TAG
catSetXMLSemantics action parameter. |
static int |
XML_ATTR_IGNORE_TAG
catSetXMLSemantics action parameter. |
static int |
XML_ATTR10_VALUE
catSetXMLSemantics action parameter. |
static int |
XML_ATTR11_VALUE
catSetXMLSemantics action parameter. |
static int |
XML_AUTO_END_TAG
catSetXMLSemantics action parameter. |
static int |
XML_CHARPOS_TAG
catSetXMLSemantics action parameter. |
static int |
XML_DATE_TAG
catSetXMLSemantics action parameter. |
static int |
XML_DOC_TAG
catSetXMLSemantics action parameter. |
static int |
XML_EMPTY_TAG
catSetXMLSemantics action parameter. |
static int |
XML_FILTER
filter parameter in catAddFile:
Use XML filter only (XML data assumed). |
static int |
XML_INT_TAG
catSetXMLSemantics action parameter. |
static int |
XML_METADATA_TAG
catSetXMLSemantics action parameter. |
static int |
XML_PAGE_TAG
catSetXMLSemantics action parameter. |
static int |
XML_PARA_TAG
catSetXMLSemantics action parameter. |
static int |
XML_REAL_TAG
catSetXMLSemantics action parameter. |
static int |
XML_TEXT_DRI2_TAG
catSetXMLSemantics action parameter. |
static int |
XML_TEXT_DRI5_TAG
catSetXMLSemantics action parameter. |
static int |
XML_TEXT_DRI6_TAG
catSetXMLSemantics action parameter. |
static int |
XML_TITLE_TAG
catSetXMLSemantics action parameter. |
Constructor Summary | |
CatalogManager()
API: CatalogManager default CONSTRUCTOR |
|
CatalogManager(boolean noCaseFiles)
API: CatalogManager CONSTRUCTOR for case sensitive file systems. |
Method Summary | |
int |
catAddFile(java.lang.String sSource,
int mode,
int filter)
API: Add a file, set of files, or multiple objects within a file to the catalog. |
int |
catAddUndo()
API: Remove all added files from catalog and remove associated STF file. |
void |
catClose()
API: Finish with Catalog object and close all resources. |
void |
catCreate(java.lang.String sRoot,
java.lang.String sPath,
java.lang.String sName,
byte[] extra,
int hashSize)
API: Create inital catalog object in specified directory path. |
long |
catDeleteByQuery(java.lang.String sQuery,
int mode)
API: Delete a set of documents that matches a search query. |
void |
catDelFile(java.lang.String sFileName)
API: Mark a catalog entry specified by file name for removal. |
void |
catDelItem(long docId,
boolean allEntries)
API: Mark a catalog entry for removal. |
void |
catEndLogging(boolean bDeleteFile)
API: Turn off API logging. |
int |
catEntryCount()
API: Retrieve the total number of entries in catalog. |
int |
catEntryDelCount()
API: Retrieve the total number of entries that have been deleted. |
int |
catEntrySize(long docId)
API: Returns the number of bytes required to hold a variable size catalog entry. |
int |
catEntryStringSize(long docId,
int item)
API: Returns the number of characters required to hold a string item from a catalog entry. |
void |
catEntryStringUpdate(long docId,
int item,
java.lang.String sUpdate)
API: Updates a string in the specified entry. |
long |
catFindFile(java.lang.String sFileName,
int mode)
API: Locate document entry by file name. |
com.doclinx.ftxml.CatalogItem |
catGetEntry(long docId)
API: Retrieves the specified catalog entry as a CatalogItem. |
java.lang.String |
catGetEntryAux(long docId)
API: ** INTERNAL ONLY ** |
byte[] |
catGetEntryBytes(long docId)
API: Retrieves the specified catalog entry as a byte array. |
com.doclinx.ftxml.CatalogItemId |
catGetEntryId(long docId)
API: Retrieves the specified catalog entry+id as a CatalogItemId. |
java.lang.Object |
catGetEntryItem(long docId,
int field)
API: Retrieves the specified catalog entry as an Object |
java.lang.String |
catGetEntryString(long docId,
int item)
API: Retrieves the specified catalog entry String item. |
void |
catImportCatalog(java.lang.String sPath,
java.lang.String sName,
int mode)
API: Import one catalog into another. |
void |
catLastEntryStringUpdateFile(java.lang.String sUpdate)
API: Updates the filename field of the last item in catalog. |
void |
catLastEntryStringUpdateURL(java.lang.String sUpdate)
API: Updates the URL field of the last item in catalog. |
void |
catMakeHashLookup(int val,
boolean pct,
boolean dup)
API: Update the catalog hash index file. |
void |
catOpen(java.lang.String sPath,
java.lang.String sName,
int mode)
API: Open an exisiting catalog object from specified directory path. |
void |
catPrimaryMerge(int mode)
API: Force merge of primary and update databases. |
int |
catSetAttr(long docId,
int value)
API: Sets the upper 16-bits of the catalog attr field. |
void |
catSetFuzzyBuild(boolean bSet,
int size,
int maxCh)
API: Enable build of fuzzy matching data structures. |
void |
catSetLogging(com.doclinx.jftr.Log lLog)
API: Set logging to exisiting Log. |
void |
catSetLogging(java.lang.String sLogName,
int level)
API: Enable logging and/or change severity level of messages. |
void |
catSetParms(com.doclinx.ftxml.SRC2STF_PARMS sPtr,
com.doclinx.ftxml.DPAPI_PARMS dPtr,
com.doclinx.ftxml.MERGE_PARMS mPtr)
API: Set parameter blocks that control add file input parsing, indexing, and database merging. |
void |
catSetStemBuild(boolean bSet,
int size)
API: Enable build of stemming data structures. |
void |
catSetXMLSemantics(int action,
java.lang.String sPathList)
API: Set XML semantic actions for specified XPATHs. |
void |
catUpdate(int mode)
API: Update catalog with added or deleted document entries. |
static java.lang.String |
explain(int iStatus)
Return English message equivalent of error code. |
static java.lang.String |
explain(int iStatus,
boolean bLong)
Return English message equivalent of error code. |
void |
finalize()
Override of Object finalize method to ensure resources released. |
java.lang.String |
getName()
|
boolean |
HAS_PRIMARY()
Return boolean indicating if catalog has a primary database built. |
boolean |
HAS_UPDATE()
Return boolean indicating if catalog has an update database built. |
void |
intCatClose(boolean closeFinal)
Internal Use Only! |
com.doclinx.ftxml.CatalogItem |
intCatGetEntry(long docId)
|
java.lang.String |
intCatGetEntryAux(long docId)
|
com.doclinx.ftxml.CatalogItemId |
intCatGetEntryId(long docId)
API: Retrieves the specified catalog entry+id as a CatalogItemId. |
java.lang.Object |
intCatGetEntryItem(long docId,
int field)
|
void |
intCatOpen(com.doclinx.jftr.BLList delList)
Internal use only! |
static boolean |
IS_ARCH(int n)
Return boolean indicating if attr value in n has
an archive bit set. |
static boolean |
IS_ARCH1(int n)
Return boolean indicating if attr value in n has
an archive bit set. |
static boolean |
IS_ARCHN(int n)
Return boolean indicating if attr value in n has
an archive bit set. |
static boolean |
IS_COMP(int n)
Return boolean indicating if attr value in n has
a composite bit set. |
static boolean |
IS_COMP1(int n)
Return boolean indicating if attr value in n has
a composite bit set. |
static boolean |
IS_COMPN(int n)
Return boolean indicating if attr value in n has
a composite bit set. |
boolean |
isOpen()
API: Query if CatalogManager class object is open. |
boolean |
NEEDS_BUILD()
|
int |
REMOVE_COUNT(int mode)
INTERNAL USE ONLY |
void |
setEntryCache(boolean set)
|
void |
setName(java.lang.String name)
|
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int CAT_SUCCESS
CAT_SUCCESS - OK: Catalog Manager API function completed correctly CAT_ERROR - General internal error -- not returned via API CAT_NOTFOUND - When requested document (#) or file does not exist CAT_FILEERROR - When file ops such as copy, rename, or delete fail CAT_BUFFERSIZE - Unable to calculate entry size incatGetEntryBytes
CAT_LOGICERROR - Internal assertion or logic check failed CAT_PARMERROR - API parameter out of range ornull
CAT_ADDERROR - ** deprecated CAT_FIXEDERROR - I/O error reading/writing catalog .idx file CAT_VARERROR - I/O error reading/writing catalog .str file CAT_LIBERROR - Error in library function -- Buffer system failure, or error compress\ing/deleting items from catalog CAT_LSTERROR - ** deprecated CAT_HASHERROR - Error building/accessing hash lookup table for file entries CAT_FILTERERROR - The parser (filter) returned an error when processing text in a file. Seecat_ExtendedError
for more information. CAT_DPERROR - Error in building inverted index. Seecat_ExtendedError
for more information. CAT_MERGEERROR - Error merging databases. Seecat_ExtendedError
for more information. CAT_DUPERROR - Attempt to add a file that already exists in catalog. CAT_STFERROR - Empty STF file, unable to build index CAT_CREATEPARSER - Unable to create parser object CAT_BADHANDLE - CatalogManager class not initialized, opened or already closed. CAT_DIRERROR - Directory does not exist or can not be created. CAT_EXISTSERROR - Requested catalog already exists incatCreate
. CAT_TO - ** deprecated CAT_CREATEXML - ** deprecated CAT_CONTEXTMERGE - Error merging context trees for XML files CAT_CONTEXTFAIL - Error building context tree CAT_FUZZYERROR - Setting fuzzy match option after catalog has indexed data. CAT_FUZZYOPEN - Error opening fuzzy logic file. CAT_FUZZYMERGE - Error merging fuzzy logic files. (corrupt) CAT_STEMERROR - Setting stemming mode after catalog has indexed data CAT_STEMOPEN - Error opening stem thesaurus file. CAT_STEMMERGE - Error merging stem thesaurus files. (corrupt). CAT_READONLYERROR - Calling catalog changing function with class open in READ ONLY mode. SeecataOpen
method. CAT_SECURITYERROR - File system security error when creating catalog directory or files. CAT_UNKNOWNERROR - Unexpected exception caught in API method. CAT_SHAREERROR - Attempt to open catalog for update and another object has catalog locked. CAT_FILEOPENERROR - ** deprecated CAT_SPARMERROR - ** deprecated CAT_PROCESSERROR - Exec parser add mode CAT_ADDEXECERROR - Exec parser add mode CAT_USERABORT - Parameter callback class abort() function request. CAT_SEARCHERROR - CatalogSearch error in catDeleteByQuery CAT_QUERYERROR - CatalogSearch query error in catDeleteByQuery CAT_NOTIMPLEMENTED - Filter not implemented. CAT_NOPRIMARY - No primary database found for merge. CAT_NOUPDATE - No update database found for merge. CAT_LICENSEEXPIRED - License has expired. CAT_LICENSEINVALID - License is invalid.
public static final int CAT_ERROR
public static final int CAT_NOTFOUND
public static final int CAT_FILEERROR
public static final int CAT_BUFFERSIZE
public static final int CAT_LOGICERROR
public static final int CAT_PARMERROR
public static final int CAT_ADDERROR
public static final int CAT_FIXEDERROR
public static final int CAT_VARERROR
public static final int CAT_LIBERROR
public static final int CAT_LSTERROR
public static final int CAT_HASHERROR
public static final int CAT_FILTERERROR
public static final int CAT_DPERROR
public static final int CAT_MERGEERROR
public static final int CAT_DUPERROR
public static final int CAT_STFERROR
public static final int CAT_CREATEPARSER
public static final int CAT_BADHANDLE
public static final int CAT_DIRERROR
public static final int CAT_EXISTSERROR
public static final int CAT_TO
public static final int CAT_CREATEXML
public static final int CAT_CONTEXTMERGE
public static final int CAT_CONTEXTFAIL
public static final int CAT_FUZZYERROR
public static final int CAT_FUZZYOPEN
public static final int CAT_FUZZYMERGE
public static final int CAT_STEMERROR
public static final int CAT_STEMOPEN
public static final int CAT_STEMMERGE
public static final int CAT_READONLYERROR
public static final int CAT_SECURITYERROR
public static final int CAT_UNKNOWNERROR
public static final int CAT_SHAREERROR
public static final int CAT_FILEOPENERROR
public static final int CAT_SPARMERROR
public static final int CAT_PROCESSERROR
public static final int CAT_ADDEXECERROR
public static final int CAT_USERABORT
public static final int CAT_SEARCHERROR
public static final int CAT_QUERYERROR
public static final int CAT_NOTIMPLEMENTED
public static final int CAT_NOPRIMARY
public static final int CAT_NOUPDATE
public static final int CAT_LICENSEEXPIRED
public static final int CAT_LICENSEINVALID
public static final int CAT_FILENAME
CatalogItem
class.
These give the data order when asking for an entry with the catGetEntryBytes
method.
public static final int CAT_ATTRS
public static final int CAT_DATE1
public static final int CAT_DATE2
public static final int CAT_DATE3
public static final int CAT_INFO
public static final int CAT_FILETYPE
public static final int CAT_FILEOFFSET
public static final int CAT_FILESIZE
public static final int CAT_AUXINFO
public static final int CAT_FILESTR
CatalogItem
class.
When accessing a string from an entry record, these values indicate
which string to retrieve/access. The 3 permitted values are:
CAT_FILESTR CAT_URLSTR CAT_AUXSTRSee the
catGetEntryString
and
catEntryStringUpdate
methods' item
parameter.
For item CAT_AUXSTR, the string returned contains 6 sub-fields, each separated by '\n'. Format: "TITLE\nABSTRACT\nENCODING\nALT_TITLE\nADD_TEXT\nPARMS" TITLE: The title string, including punctuation of document e.g. An HTML file, the data between... ABSTRACT: Any abstract or summary info found in document. ENCODING: Encoding specified by file (e.g. UTF-8) ALT_TITLE: User supplied link/title (e.g. ref text). ADD_TEXT: Misc. added user text (NOT indexed) PARMS: Parameter data provided by application callback function.
public static final int CAT_URLSTR
public static final int CAT_AUXSTR
public static final int CAT_AUX_TITLE
For item CAT_AUXSTR, the string returned contains 6 sub-fields, each separated by '\n'. The following constants are the sub-field defintions. Format: "TITLE\nABSTRACT\nENCODING\nALT_TITLE\nADD_TEXT\nPARMS" TITLE: The title string, including punctuation of document e.g. An HTML file, the data between... ABSTRACT: Any abstract or summary info found in document. (indexed) ENCODING: Encoding specified by file (e.g. UTF-8) (not indexed) ALT_TITLE: User supplied link/title (e.g. ref text). (optionally indexed) ADD_TEXT: Misc. added user text (NOT indexed) PARMS: Parameter data provided by application callback function. (indexed)
public static final int CAT_AUX_ABSTRACT
public static final int CAT_AUX_ENCODING
public static final int CAT_AUX_ALTTITLE
public static final int CAT_AUX_ADDTEXT
public static final int CAT_AUX_PARMS
public static final int CAT_OPENREADONLY
mode
parameter values: Open catalog for search
public static final int CAT_OPENUPDATE
mode
parameter values: Open catalog for update
public static final int CAT_OPENRESTORE
mode
parameter values: Allow catalog RESTORE
public static final int NO_FILTER
filter
parameter in catAddFile:
Indicates STF format for file(s) being added (no filter)
public static final int HTML_FILTER
filter
parameter in catAddFile:
Use HTML filter only (HTML data assumed).
public static final int XML_FILTER
filter
parameter in catAddFile:
Use XML filter only (XML data assumed).
public static final int GENERIC_FILTER
filter
parameter in catAddFile:
Use general filter to parse based on file type.
public static final int TEXT_FILTER
filter
parameter in catAddFile:
Use text only (no markup) filter. (very fast).
public static final int DETECT_FILTER
filter
parameter in catAddFile:
Parser attempts to determine format of file and
then best filter to use.
public static final int ADD_MODE_FILE
mode
parameter for controlling adding files to catalog:
sSource
parameter is a single file path.
public static final int ADD_MODE_LOF
mode
parameter for controlling adding files to catalog:
sSource
parameter is a file containing path names,
one path name per line. No blanks lines or comments in file.
public static final int ADD_MODE_DIR
mode
parameter for controlling adding files to catalog:
sSource
parameter is a directory path.
All files in directory are added. Any subdirectores are
recursively traversed.
public static final int ADD_MODE_MAPFILE
mode
parameter for controlling adding files to catalog:
sSource
parameter is a map file. A map file is a CSV
list used primarily as web-crawler input specification. Each line
corresponds to one file entry.
Line format: URL,path,title,mimetype,encoding
public static final int ADD_MODE_INPUTCBACK
mode
parameter for controlling adding files to catalog:
sSource
parameter is a file name in the default mode.
Applications can extend the callback to do their own opens on one or more
files (e.g. sSource could be a directory and the application
extends the callback to do "secure" opens, returning a stream for
each item in the directory).
See also InputCallback
class.
Note: sSource is *usually* the name of the file(s) to open.
public static final int ADD_MODE_MODIFIED
mode
parameter for controlling adding files to catalog:
If file(s) exist in catalog and have been changed, delete entry
and add new version. If new, then add file as normal.
public static final int ADD_MODE_AUTODEL
mode
parameter for controlling adding files to catalog:
If file(s) exist, then delete current entry and then add.
public static final int ADD_MODE_RESTART
mode
parameter for controlling adding files to catalog:
C++ version ONLY!
public static final int ADD_MODE_PROCESSFILE
mode
parameter for controlling adding files to catalog:
C++ version ONLY!
public static final int ADD_MODE_RECOVER
mode
parameter for controlling adding files to catalog:
C++ version ONLY!
public static final int ADD_MODE_JDBC
mode
parameter for extracting data from a db via JDBC
public static final int ADD_MODE_NODUPCHK
mode
parameter to prevent duplicate file name check.
public static final int ADD_MODE_IGNOREDUP
mode
parameter to skip duplicate file names.
public static final int FIND_MODE_ALL
mode
parameter for controlling which file to locate
in the catalog.
See also catFindFile
method.
FIND_MODE_ALL - Find file regardless. FIND_MODE_DEL - Find file only if marked as deleted. FIND_MODE_NOTDEL - Find file only if NOT marked as deleted.
public static final int FIND_MODE_DEL
mode
parameter.
public static final int FIND_MODE_NOTDEL
mode
parameter.
public static final int MODE_PRIMARY
mode
parameter for controlling update process.
See also catUpdate
and catImportCatalog
method.
Notes: 1. Bit values for the 1st 2 settings mutually exclusive.
2. The 1st two settings are ignored for catImportCatalog
MODE_PRIMARY - Indicates that update operation should result in only a single, primary index. If an update database exists, it is merged. MODE_PRIMARY should only be used when th application determines that the update DB is getting too large (e.g. > 10-25% of primary size). MODE_UPDATE - Indicates that added files are to be indexed in the update database. If no database exists, then the primary index is created and no update DB is required. This is the typical update mode. MODE_REMOVE_DELS - Remove any entries marked as deleted from the database index. They remain in the catalog. MODE_COMPRESS_CAT - Remove deleted entries from catalog. REMOVE_DELS must be set. MODE_REHASH - Rebuild file name hash table after update completed. MODE_MIN_LOCSIZE - When removing deletions, recalculate index mimimums for smallest possible index file size. REMOVE_DELS must be set.
public static final int MODE_UPDATE
mode
parameter (bit field setting)
public static final int MODE_REMOVE_DELS
mode
parameter (bit field setting)
public static final int MODE_COMPRESS_CAT
mode
parameter (bit field setting)
public static final int MODE_REHASH
mode
parameter (bit field setting)
public static final int MODE_MIN_LOCSIZE
mode
parameter (bit field setting)
public static final int MODE_IMPORT_AUTODEL
mode
parameter (bit field setting)
public static final int MODE_IMPORT_HASHLOAD
mode
parameter (bit field setting)
public static final int MODE_IMPORT_NODUPCHK
mode
parameter (bit field setting)
public static final int CLEAR_SEMANTICS
action
parameter values for XPATH semantics.
These are the semantic action that can be associated with a static
XPATH value list. XML semantics only work with XML files with context
trees.
Values are bit patterns and are usually mutually exclusive.
See also catSetXMLSemantics
method.
CLEAR_SEMANTICS - Reset all semantics for specified paths. XML_ATTR10_VALUE - The value of this XML attribute is put into 16-bit integer attribute 10 (Must be integer OR single alphabetic letter: 'a' -> 1, 'b' -> 2, etc.) XML_ATTR11_VALUE - The value of this XML attribute is put into 16-bit integer attribute 11 (Must be integer OR single alphabetic letter: 'a' -> 1, 'b' -> 2, etc.) XML_AUTO_END_TAG - HTML <tag> that closes when another like tag OR parent end tag is encountered (E.g. <LI>) XML_TITLE_TAG - This tag contains the title of the document. XML_ABSTRACT_TAG - This tag contains abstract or summary information about document content. XML_PARA_TAG - This tag starts a new paragraph. Can be used with TITLE or abstract settings. XML_DATE_TAG - This tag or attribute contains a date represented as a 32 bit integer (yyyy << 16 + mm << 8 + dd). XML_INT_TAG - This tag or attribute contains integer data. XML_REAL_TAG - This tag or attribute contains floating pt. data. XML_DOC_TAG - This tag is the start of a new document. See composite file description. XML_EMPTY_TAG - HTML: This file has no end tag. XML_TEXT_DRI2_TAG - Place text in Text DRI region 2 XML_TEXT_DRI5_TAG - Place text in Text DRI region 5 XML_TEXT_DRI6_TAG - Place text in Text DRI region 6 (sub aaidx on 15) XML_ADD2_DRI0_TAG - Also place DRI[2,5,6] text in DRI 0 XML_ATTR_1WRD_TAG - ALSO index an attribute as a single word XML_METADATA_TAG - Tags attributes are metadata saved in catalog
public static final int XML_ATTR10_VALUE
action
parameter.
public static final int XML_ATTR11_VALUE
action
parameter.
public static final int XML_AUTO_END_TAG
action
parameter.
public static final int XML_TITLE_TAG
action
parameter.
public static final int XML_ABSTRACT_TAG
action
parameter.
public static final int XML_PARA_TAG
action
parameter.
public static final int XML_INT_TAG
action
parameter.
public static final int XML_REAL_TAG
action
parameter.
public static final int XML_DOC_TAG
action
parameter.
public static final int XML_EMPTY_TAG
action
parameter.
public static final int XML_DATE_TAG
action
parameter.
public static final int XML_TEXT_DRI2_TAG
action
parameter.
public static final int XML_TEXT_DRI5_TAG
action
parameter.
public static final int XML_TEXT_DRI6_TAG
action
parameter.
public static final int XML_ADD2_DRI0_TAG
action
parameter.
public static final int XML_ATTR_1WRD_TAG
action
parameter.
public static final int XML_METADATA_TAG
action
parameter.
public static final int XML_CHARPOS_TAG
action
parameter.
public static final int XML_PAGE_TAG
action
parameter.
public static final int XML_ATTR_IGNORE_TAG
action
parameter.
public static java.lang.String TEMPLATE
public static java.lang.String CONFIG_FILE
public static java.lang.String COPYRIGHT
public static java.lang.String CAT_FIXED
public static java.lang.String CAT_STRS
public static java.lang.String CAT_HASH
public static java.lang.String CAT_INF
public static java.lang.String EXE_NAME
public static java.lang.String CAT_RESTORE
public java.lang.String CAT_LOG_FILENAME
public static java.lang.String CONTEXT_IDX
public static java.lang.String CONTEXT_STR
public static java.lang.String CONTEXT_IDXP
public static java.lang.String CONTEXT_STRP
public static java.lang.String CONTEXT_IDXU
public static java.lang.String CONTEXT_STRU
public static java.lang.String CONTEXT_IDX2
public static java.lang.String CONTEXT_STR2
public static java.lang.String FUZZY_PRM
public static java.lang.String FUZZY_UPD
public static java.lang.String FUZZY_UPD2
public static java.lang.String STEM_PRM
public static java.lang.String STEM_UPD
public static java.lang.String STEM_UPD2
public static java.lang.String THES_EXT
public static java.lang.String CAT_EXT
public static java.lang.String CAT_LOG
public static java.lang.String TEMPDB_EXT
public static java.lang.String PRIMARY_EXT
public static java.lang.String UPDATE_EXT
public static java.lang.String UPDATE2_EXT
public static java.lang.String STF_EXT
public static java.lang.String CAT_TMP
public static int FIXED_BLKMIN
public static int STRS_BLKMIN
public static int HASH_BLKMIN
public static int LRU_BLKMIN
public static int LRU_BLKSIZE
public static int FIXED_ELTS
public static int CAT_DEFHASH
public static final int MAX_FLD
public static final int FLD_EOD
public static final int FLD_STRING
public static final int FLD_BITS32
public static final int FLD_UINT32
public static final int FLD_DATE
public static final int FLD_UINT16
public static final int FLD_UINT64
public static final int FLD_MASK
public static final byte DEFAULT_CONTEXT_AAIDX
public static char PATH_DELIM
public static java.lang.String PATH_DELIMS
public static java.lang.String ARCH_SEP
public static java.lang.String COMP_SEP
public byte cat_nFields
public byte[] cat_Flds
public int cat_MaxPrimaryItem
public boolean cat_FuzzySearchEnable
public boolean cat_StemEnable
public java.lang.String cat_Name
public java.lang.String cat_Path
public com.doclinx.jftr.Log cat_Log
public int cat_ExtendedError
public int cat_Mode
public boolean cat_IsObsolete
public com.doclinx.ftxml.SRC2STF_PARMS cat_sParms
public com.doclinx.jftr.BLList cat_DelList
public com.doclinx.ftxml.Map cat_XMLSemantics
public static com.doclinx.ftxml.UpdateLock updateLock
Constructor Detail |
public CatalogManager()
**none
- **public CatalogManager(boolean noCaseFiles)
noCaseFiles
- If true, system file names are NOT case sensitive
**none**
Method Detail |
public static boolean IS_ARCH(int n)
n
has
an archive bit set.
n
- An attr bit value. See CatalogItem.attrs
.
true
if entry attr has one of the archive bits set.
**none
- **public static boolean IS_ARCH1(int n)
n
has
an archive bit set.
n
- An attr bit value. See CatalogItem.attrs
.
true
if entry is 1st file in archive.
**none
- **public static boolean IS_ARCHN(int n)
n
has
an archive bit set.
n
- An attr bit value. See CatalogItem.attrs
.
true
if entry is 2nd-nth file in archive.
**none
- **public static boolean IS_COMP(int n)
n
has
a composite bit set.
n
- A composite bit value. See CatalogItem.attrs
.
true
if entry attr has one of the composite file bits set.
**none
- **public static boolean IS_COMP1(int n)
n
has
a composite bit set.
n
- A composite bit value. See CatalogItem.attrs
.
true
if entry attr is first composite file.
**none
- **public static boolean IS_COMPN(int n)
n
has
a composite bit set.
n
- A composite bit value. See CatalogItem.attrs
.
true
if entry attr is first composite file.
**none
- **public void setEntryCache(boolean set)
public void setName(java.lang.String name)
public java.lang.String getName()
public static java.lang.String explain(int iStatus)
iStatus
- Error code #.
Error Codes.
public static java.lang.String explain(int iStatus, boolean bLong)
iStatus
- Error code #.bLong
- If true, return long version of explanation.
Error Codes.
public boolean HAS_PRIMARY()
true
if primary database exists.
**none
- **public boolean HAS_UPDATE()
true
if update database exists.
**none
- **public boolean NEEDS_BUILD()
public int REMOVE_COUNT(int mode)
public void finalize()
finalize
in class java.lang.Object
**none
- **public boolean isOpen()
true
if CatalogManager object is opened.
**none**
catCreate.
,
catOpen.
,
catClose.
public void catCreate(java.lang.String sRoot, java.lang.String sPath, java.lang.String sName, byte[] extra, int hashSize) throws CatalogMgrException
sRoot
- Path of root directory containing stub/parameterssPath
- Directory path of catalog main root.sName
- Name of catalog subdirectory -- must not already exist.extra
- Additional field designators (optional, null
OK)hashSize
- Initial size of entry lookup table. Use 0 for default value.
CatalogMgrException
- See error codes
.catClose.
public void catOpen(java.lang.String sPath, java.lang.String sName, int mode) throws CatalogMgrException
sPath
- Directory path of catalog main root.sName
- Name of catalog subdirectory -- must already exist.mode
- Catalog access read-only or for updating, see open modes
.
CatalogMgrException
- See constant
definitions.catClose.
public void intCatOpen(com.doclinx.jftr.BLList delList) throws CatalogMgrException
CatalogMgrException
public void catClose() throws CatalogMgrException
CatalogMgrException
- See constant
definitions.catOpen.
,
catCreate.
public void intCatClose(boolean closeFinal) throws CatalogMgrException
CatalogMgrException
public void catDelItem(long docId, boolean allEntries) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.allEntries
- If true and entry is composite or archive, then
all sibling entries are also removed.
CatalogMgrException
- See constant
definitions.catUpdate.
public void catDelFile(java.lang.String sFileName) throws CatalogMgrException
sFileName
- File name (without path) of entry to delete.
CatalogMgrException
- See constant
definitions.catUpdate.
public int catAddFile(java.lang.String sSource, int mode, int filter) throws CatalogMgrException
SRC2STF_PARMS
SRC2STF_PARMS
control structure provides additional control and parametric
values for the conversion process.
sSource
- Location of file, directory path, or file containing
list of files.mode
- Control bits for specifying control of add operation.
Note: mode setting are bit values and more that one bit can be set where appropriate. The are six modes that control how to treat the source parameter and are mutually exclusive (marked with '!'). If a file already exists in a catalog, it is not added, unless MODE_MODIFIED or MODE_AUTODEL is specified.ADD_MODE_FILE !-SeesSource
parameter is a single file path. ADD_MODE_LOF !-sSource
parameter is a file containing path names, one path name per line. No blanks lines or comments in file. ADD_MODE_DIR !-sSource
parameter is a directory path. All files in directory are added. Any subdirectores are recursively traversed. ADD_MODE_MAPFILE !-sSource
parameter is a map file. A map file is a CSV list used primarily as web- crawler input specification. Each line corresponds to one file entry. Line format: URL,path,title,mimetype,encoding ADD_MODE_JDBC !-sSource
is parameter passed to the JDBCaccess class. (JDBCaccess.getInstance(sSource)); ADD_MODE_INPUTCBACK !-sSource
parameter is a file/dir reference (or ""). The InputCallback class is used to open a for reading data input. ADD_MODE_MODIFIED - If file(s) exist in catalog and have been changed, delete entry and add new version. If new, just add. ADD_MODE_AUTODEL - If file(s) exist, then delete current entry and then add new version. ADD_MODE_RESTART - C++ version only ADD_MODE_PROCESSFILE - C++ version only ADD_MODE_RECOVER - C++ version only ADD_MODE_IGNOREDUP - If file(s) exist in catalog, just ignore.mode
bit settings.
filter
- Specify filter (parser) to use to decode text file.
Or, have parser attempt to determine file type(s).
Filter type for filter
parameter (one only):
NO_FILTER - implies STF format for file(s) being added.
DETECT FILTER - Parser attempts to determine format of file and
best filter.
HTML_FILTER - Use HTML filter only (HTML data assumed).
XML_FILTER - Use XML filter only (XML data assumed).
GENERIC_FILTER - Use general filter to parse based on file type.
TEXT_FILTER - Use text only (no markup) filter. (very fast).
See filter
control setting.
CatalogMgrException
- See constant
definitions.catUpdate method.
public int catAddUndo() throws CatalogMgrException
CatalogMgrException
- See constant
definitions.catAddFile.
public int catEntryCount() throws CatalogMgrException
CatalogMgrException
- See constant
definitions.catUpdate.
public int catEntryDelCount() throws CatalogMgrException
CatalogMgrException
- See constant
definitions.catUpdate.
public int catEntrySize(long docId) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.
CatalogMgrException
- See constant
definitions.CatalogItem.
public int catEntryStringSize(long docId, int item) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.item
- Selects which string to retrieve. See string
access definitions.
CatalogMgrException
- See constant
definitions.CatalogItem.
public void catEntryStringUpdate(long docId, int item, java.lang.String sUpdate) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.item
- Selects which string to retrieve. See string
access definitions.sUpdate
- New string value (must be in UNICODE encoding).
CatalogMgrException
- See constant
definitions.CatalogItem.
public void catLastEntryStringUpdateFile(java.lang.String sUpdate) throws CatalogMgrException
sUpdate
- New string value of CAT_FILESTR string (must be in UNICODE encoding).
CatalogMgrException
- See constant
definitions.CatalogItem.
public void catLastEntryStringUpdateURL(java.lang.String sUpdate) throws CatalogMgrException
sUpdate
- New string value of CAT_URLSTR string (must be in UNICODE encoding).
CatalogMgrException
- See constant
definitions.CatalogItem.
public com.doclinx.ftxml.CatalogItem catGetEntry(long docId) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.
CatalogMgrException
- See constant
definitions.CatalogItem.
public com.doclinx.ftxml.CatalogItem intCatGetEntry(long docId) throws CatalogMgrException
CatalogMgrException
public java.lang.Object catGetEntryItem(long docId, int field) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.field
- Field to retrieve
CatalogMgrException
- See constant
definitions.public java.lang.Object intCatGetEntryItem(long docId, int field) throws CatalogMgrException
CatalogMgrException
public com.doclinx.ftxml.CatalogItemId catGetEntryId(long docId) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.
CatalogMgrException
- See constant
definitions.CatalogItemId.
public com.doclinx.ftxml.CatalogItemId intCatGetEntryId(long docId) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.
CatalogMgrException
- See constant
definitions.CatalogItemId.
public byte[] catGetEntryBytes(long docId) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.
CatalogMgrException
- See constant
definitions.CatalogItem.
public java.lang.String catGetEntryString(long docId, int item) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.item
- Selects which string to retrieve. See string
access definitions.
CatalogMgrException
- See constant
definitions.CatalogItem.
public void catUpdate(int mode) throws CatalogMgrException
mode
- Mode of operation, see mode values
for details.
CatalogMgrException
- See constant
definitions.public void catPrimaryMerge(int mode) throws CatalogMgrException
mode
- Mode of operation, see mode values
for details.
CatalogMgrException
- See constant
definitions.public void catMakeHashLookup(int val, boolean pct, boolean dup) throws CatalogMgrException
val
- If 0, use uses current hash size.
If pct true, then hash size is % load factor,
else val sets hash size to this absolute #.pct
- If true, val is a pecentage (0..100) for load factor,
else val is fixed # of buckets in hash table.dup
- Force checking for duplicate entries.
CatalogMgrException
- See constant
definitions.public long catFindFile(java.lang.String sFileName, int mode) throws CatalogMgrException
sFileName
- Entry name to to search, value of file name field (UNICODE).mode
- Controls file match, see mode
defintions.
CatalogMgrException
- See constant
definitions.public void catSetLogging(java.lang.String sLogName, int level) throws CatalogMgrException
sLogName
- Full path of logging file.level
- Severity level, see debug
settings.
CatalogMgrException
- See constant
definitions.public void catSetLogging(com.doclinx.jftr.Log lLog) throws CatalogMgrException
lLog
- Opened logger
CatalogMgrException
- See constant
definitions.public void catEndLogging(boolean bDeleteFile) throws CatalogMgrException
bDeleteFile
- Remove current logging file if true
.
CatalogMgrException
- See constant
definitions.public void catSetParms(com.doclinx.ftxml.SRC2STF_PARMS sPtr, com.doclinx.ftxml.DPAPI_PARMS dPtr, com.doclinx.ftxml.MERGE_PARMS mPtr) throws CatalogMgrException
sPtr
- Source conversion control parameter block. (null
OK)dPtr
- Database build (index) control parameter block. (null
OK)mPtr
- Merge database control parameter block. (null
OK)
CatalogMgrException
- See constant
definitions.parameter block definitions.
,
parameter block definitions.
,
parameter block definitions.
public void catSetFuzzyBuild(boolean bSet, int size, int maxCh) throws CatalogMgrException
bSet
- If true
, enable build of fuzzy match data structures.size
- Size of hash index for fuzzy lookup. (0, use default).maxCh
- Maximum length of lookup line (0 implies no maximum).
CatalogMgrException
- See constant
definitions.public void catSetStemBuild(boolean bSet, int size) throws CatalogMgrException
bSet
- Enable/Disable stemming flag (catalog default is no stemming).size
- % size of hash table for lookup
CatalogMgrException
- See constant
definitions.public void catSetXMLSemantics(int action, java.lang.String sPathList) throws CatalogMgrException
action
- Bit pattern specifying parsers actions when encountering tag.sPathList
- ',' separated list of XPATHs denoting tags.
CatalogMgrException
- See constant
definitions.bit settings for permissable actions.
public void catImportCatalog(java.lang.String sPath, java.lang.String sName, int mode) throws CatalogMgrException
sPath
- Directory path of catalog to import main root.sName
- Name of import catalog subdirectory -- must already exist.mode
- Mode of operation, see mode values
for details.
CatalogMgrException
- See constant
definitions.public int catSetAttr(long docId, int value) throws CatalogMgrException
docId
- Ordinal number of document entry, range 1..# of documents.value
- 32-bit integer value. The upper 16-bits are copied to the
attr field.
CatalogMgrException
- See constant
definitions.public long catDeleteByQuery(java.lang.String sQuery, int mode) throws CatalogMgrException, CatalogSearchException
sQuery
- Simple boolean query string for specifying search.mode
- Specifies which DB to search and other search options.
See MODE_PRIMARY
for start of discussion about search modes and options.
CatalogMgrException
- See constant
definitions.
CatalogSearchException
public java.lang.String catGetEntryAux(long docId) throws CatalogMgrException
CatalogMgrException
public java.lang.String intCatGetEntryAux(long docId) throws CatalogMgrException
CatalogMgrException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |